/*
 * Copyright (c) 2020 pig4cloud Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.bblocks.common.data;

import java.lang.annotation.*;

/**
 * swaggerHead注释描述
 *
 * @author Jin
 * @date 2024-2-28
 */

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface SwaggerHead {

	/**
	 * 说明
	 * @return 值
	 */
	String value() default "";

	/**
	 * 是否必须
	 * @return
	 */
	boolean required() default false;

	/**
	 * 参数值类型：header、query、path、cookie等
	 * @return
	 */
	String inType() default "header";

}
